home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cptsvx.z / cptsvx
Encoding:
Text File  |  2002-10-03  |  8.0 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCPPPPTTTTSSSSVVVVXXXX((((3333SSSS))))                                                          CCCCPPPPTTTTSSSSVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CPTSVX - use the factorization A = L*D*L**H to compute the solution to a
  10.      complex system of linear equations A*X = B, where A is an N-by-N
  11.      Hermitian positive definite tridiagonal matrix and X and B are N-by-NRHS
  12.      matrices
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      SUBROUTINE CPTSVX( FACT, N, NRHS, D, E, DF, EF, B, LDB, X, LDX, RCOND,
  16.                         FERR, BERR, WORK, RWORK, INFO )
  17.  
  18.          CHARACTER      FACT
  19.  
  20.          INTEGER        INFO, LDB, LDX, N, NRHS
  21.  
  22.          REAL           RCOND
  23.  
  24.          REAL           BERR( * ), D( * ), DF( * ), FERR( * ), RWORK( * )
  25.  
  26.          COMPLEX        B( LDB, * ), E( * ), EF( * ), WORK( * ), X( LDX, * )
  27.  
  28. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  29.      These routines are part of the SCSL Scientific Library and can be loaded
  30.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  31.      directs the linker to use the multi-processor version of the library.
  32.  
  33.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  34.      4 bytes (32 bits). Another version of SCSL is available in which integers
  35.      are 8 bytes (64 bits).  This version allows the user access to larger
  36.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  37.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  38.      only one of the two versions; 4-byte integer and 8-byte integer library
  39.      calls cannot be mixed.
  40.  
  41. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  42.      CPTSVX uses the factorization A = L*D*L**H to compute the solution to a
  43.      complex system of linear equations A*X = B, where A is an N-by-N
  44.      Hermitian positive definite tridiagonal matrix and X and B are N-by-NRHS
  45.      matrices. Error bounds on the solution and a condition estimate are also
  46.      provided.
  47.  
  48.  
  49. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  50.      The following steps are performed:
  51.  
  52.      1. If FACT = 'N', the matrix A is factored as A = L*D*L**H, where L
  53.         is a unit lower bidiagonal matrix and D is diagonal.  The
  54.         factorization can also be regarded as having the form
  55.         A = U**H*D*U.
  56.  
  57.      2. If the leading i-by-i principal minor is not positive definite,
  58.         then the routine returns with INFO = i. Otherwise, the factored
  59.         form of A is used to estimate the condition number of the matrix
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCPPPPTTTTSSSSVVVVXXXX((((3333SSSS))))                                                          CCCCPPPPTTTTSSSSVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.         A.  If the reciprocal of the condition number is less than machine
  75.         precision, INFO = N+1 is returned as a warning, but the routine
  76.         still goes on to solve for X and compute error bounds as
  77.         described below.
  78.  
  79.      3. The system of equations is solved for X using the factored form
  80.         of A.
  81.  
  82.      4. Iterative refinement is applied to improve the computed solution
  83.         matrix and calculate error bounds and backward error estimates
  84.         for it.
  85.  
  86.  
  87. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  88.      FACT    (input) CHARACTER*1
  89.              Specifies whether or not the factored form of the matrix A is
  90.              supplied on entry.  = 'F':  On entry, DF and EF contain the
  91.              factored form of A.  D, E, DF, and EF will not be modified.  =
  92.              'N':  The matrix A will be copied to DF and EF and factored.
  93.  
  94.      N       (input) INTEGER
  95.              The order of the matrix A.  N >= 0.
  96.  
  97.      NRHS    (input) INTEGER
  98.              The number of right hand sides, i.e., the number of columns of
  99.              the matrices B and X.  NRHS >= 0.
  100.  
  101.      D       (input) REAL array, dimension (N)
  102.              The n diagonal elements of the tridiagonal matrix A.
  103.  
  104.      E       (input) COMPLEX array, dimension (N-1)
  105.              The (n-1) subdiagonal elements of the tridiagonal matrix A.
  106.  
  107.      DF      (input or output) REAL array, dimension (N)
  108.              If FACT = 'F', then DF is an input argument and on entry contains
  109.              the n diagonal elements of the diagonal matrix D from the
  110.              L*D*L**H factorization of A.  If FACT = 'N', then DF is an output
  111.              argument and on exit contains the n diagonal elements of the
  112.              diagonal matrix D from the L*D*L**H factorization of A.
  113.  
  114.      EF      (input or output) COMPLEX array, dimension (N-1)
  115.              If FACT = 'F', then EF is an input argument and on entry contains
  116.              the (n-1) subdiagonal elements of the unit bidiagonal factor L
  117.              from the L*D*L**H factorization of A.  If FACT = 'N', then EF is
  118.              an output argument and on exit contains the (n-1) subdiagonal
  119.              elements of the unit bidiagonal factor L from the L*D*L**H
  120.              factorization of A.
  121.  
  122.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  123.              The N-by-NRHS right hand side matrix B.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCPPPPTTTTSSSSVVVVXXXX((((3333SSSS))))                                                          CCCCPPPPTTTTSSSSVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDB     (input) INTEGER
  141.              The leading dimension of the array B.  LDB >= max(1,N).
  142.  
  143.      X       (output) COMPLEX array, dimension (LDX,NRHS)
  144.              If INFO = 0 or INFO = N+1, the N-by-NRHS solution matrix X.
  145.  
  146.      LDX     (input) INTEGER
  147.              The leading dimension of the array X.  LDX >= max(1,N).
  148.  
  149.      RCOND   (output) REAL
  150.              The reciprocal condition number of the matrix A.  If RCOND is
  151.              less than the machine precision (in particular, if RCOND = 0),
  152.              the matrix is singular to working precision.  This condition is
  153.              indicated by a return code of INFO > 0.
  154.  
  155.      FERR    (output) REAL array, dimension (NRHS)
  156.              The forward error bound for each solution vector X(j) (the j-th
  157.              column of the solution matrix X).  If XTRUE is the true solution
  158.              corresponding to X(j), FERR(j) is an estimated upper bound for
  159.              the magnitude of the largest element in (X(j) - XTRUE) divided by
  160.              the magnitude of the largest element in X(j).
  161.  
  162.      BERR    (output) REAL array, dimension (NRHS)
  163.              The componentwise relative backward error of each solution vector
  164.              X(j) (i.e., the smallest relative change in any element of A or B
  165.              that makes X(j) an exact solution).
  166.  
  167.      WORK    (workspace) COMPLEX array, dimension (N)
  168.  
  169.      RWORK   (workspace) REAL array, dimension (N)
  170.  
  171.      INFO    (output) INTEGER
  172.              = 0:  successful exit
  173.              < 0:  if INFO = -i, the i-th argument had an illegal value
  174.              > 0:  if INFO = i, and i is
  175.              <= N:  the leading minor of order i of A is not positive
  176.              definite, so the factorization could not be completed, and the
  177.              solution has not been computed. RCOND = 0 is returned.  = N+1: U
  178.              is nonsingular, but RCOND is less than machine precision, meaning
  179.              that the matrix is singular to working precision.  Nevertheless,
  180.              the solution and error bounds are computed because there are a
  181.              number of situations where the computed solution can be more
  182.              accurate than the value of RCOND would suggest.
  183.  
  184. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  185.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  186.  
  187.      This man page is available only online.
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.